Configuring SIP Recording Rules

The SIP Recording Rules table lets you configure up to 30 SIP-based media recording (SIPREC) rules. A SIP Recording rule defines call routes that you want to record. For an overview of the feature, see SIP-based Media Recording.

● To configure the device's timestamp format (local or UTC) in SIP messages sent to the SRS, see the [SIPRecTimeStamp] parameter.
● When recording SRTP-to-SRTP calls, if you want to send the recorded media to the SRS as RTP (i.e., decrypted), add an IP Profile for the SRS and configure its 'SBC Media Security Mode' parameter to Not Secured (see Configuring IP Profiles).
● If you configure a SIP Recording rule for calls that have also been configured for direct media (media bypass) by a SIP Interface ('Direct Media' parameter) or an IP Profile ('Direct Media Tag' parameter), the device automatically disables direct media for these calls (during their SIP signaling setup). This ensures that media traverses the device so that it can be recorded and sent to the SRS. However, if you enable direct media using the [SBCDirectMedia] global parameter (i.e., all calls), or calls whose incoming SIP dialog-initiating request contain the proprietary header X-AC-Action with the value 'direct-media' (i.e., 'X-AC-Action: direct-media'), direct media is always enforced and calls aren't recorded.
● To view the number of currently active SIPREC signaling sessions, use the CLI command show voip calls statistics siprec. For more information, refer to the document CLI Reference Guide.

The following procedure describes how to configure SIP Recording rules through the Web interface. You can also configure it through ini file [SIPRecRouting] or CLI (configure voip > sip-definition sip-recording sip-rec-routing).

➢ To configure a SIP Recording rule:
1. Open the SIP Recording Rules table (Setup menu > Signaling & Media tab > SIP Recording folder > SIP Recording Rules).
2. Click New; the following dialog box appears:

The following configuration records calls made by IP Group "ITSP" to IP Group "IP-PBX" that have the destination number prefix "1800". The device records the calls from the leg interfacing with IP Group "IP PBX" (peer) and sends the recorded media to IP Group "SRS-1". SRS redundancy has also been configured, where IP Group "SRS-1" is the active SRS and IP Group "SRS-2" the standby SRS.

● 'Recorded IP Group': "ITSP"
● 'Recorded Destination Pattern': "1800"
● 'Peer IP Group': "IP-PBX"
● 'Caller': Peer Party
● 'Recording Server (SRS) IP Group': "SRS-1"
● 'Redundant Recording Server (SRS) IP Group': "SRS-2"
1. Configure a SIP recording rule according to the parameters described in the table below.
2. Click Apply, and then save your settings to flash memory.

SIP Recording Rules Table Parameter Descriptions

Parameter

Description
General

'Index'

[Index]

Defines an index number for the new table record.

'Recorded IP Group'

recorded-ip-group-name

[RecordedIPGroupName]

Assigns an IP Group from the IP Groups table (see Configuring IP Groups) to represent the entity participating in the call. Recording is done on the leg interfacing with this IP Group.

The default is Any (i.e., all IP Groups).

Note:

■ The parameter is mandatory.
■ For an SBC RTP-SRTP session, the recorded IP Group must be set to the RTP leg if recording is required to be RTP, or set to the SRTP leg if recording is required to be SRTP.

'Recorded Source Pattern'

recorded-src-pattern

[RecordedSourcePrefix]

Defines calls to record based on source number or SIP URI.

You can use special patterns (notations) to denote the number or URI. For example, if you want to match this rule to user parts whose last four digits (i.e., suffix) are 4 followed by any three digits (e.g., 4008), then configure this parameter to "(4xxx)". For available patterns, see Patterns for Denoting Phone Numbers and SIP URIs.

The default value is the asterisk (*) symbol, meaning any source number or URI.

'Recorded Destination Pattern'

recorded-dst-prefi

[RecordedDestinationPrefix]

Defines calls to record based on destination number or URI.

You can use special patterns (notations) to denote the number or URI. For example, if you want to match this rule to user parts whose last four digits (i.e., suffix) are 4 followed by any three digits (e.g., 4008), then configure this parameter to "(4xxx)". For available patterns, see Patterns for Denoting Phone Numbers and SIP URIs.

The default value is the asterisk (*) symbol, meaning any destination number or URI.

'Condition'

condition-name

[ConditionName]

Assigns a Message Condition rule from the Message Conditions table ( see Configuring Message Condition Rules) to the rule, which starts (activates) call recording upon a specific condition.

For more information on using conditions with SIPREC, see Using Message Conditions for Starting a SIPREC Session.

'Peer IP Group'

peer-ip-group-name

[PeerIPGroupName]

Assigns an IP Group from the IP Groups table (see Configuring IP Groups) to represent the peer IP Group that is participating in the call.

The default is Any (i.e., all IP Groups).

'Peer Trunk Group ID'

peer-trunk-group-id

[PeerTrunkGroupID]

Defines the peer Trunk Group that is participating in the call. To configure Trunk Groups, see Configuring Trunk Groups.

Note: The parameter is applicable only to the Gateway application.

'Caller'

caller

[Caller]

Defines which calls to record according to which party is the caller.

■ [0] Both = (Default) Caller can be peer or recorded side
■ [1] Recorded Party (in Gateway, IP-to-Tel call)
■ [2] Peer Party (in Gateway, Tel-to-IP call)

'Trigger'

trigger

[RecordingTrigger]

Defines what triggers (starts) the device to record the call for this rule.

■ [0] Call Connect = (Default) Call recording is triggered when the call is established (200 OK or ACK received).
■ [1] REST = Call recording is triggered when the device receives a REST request. For more information on SIPREC triggered by REST, see On-Demand SIPREC using REST.
■ [2] Media Start = Call recording is triggered upon the start of media. This can include early media (18x response prior to 200 OK, e.g., to play ring tone) or media after connect.

Note: For alternate call routing or forking scenarios, if SIPREC was triggered due to early media and another SIP 183/200 OK changes the destination which is not configured for recording, the device continues recording the call.

'Recording Server Role'

srs-role

[SRSRole]

Defines a condition (optional) based on role value for matching the rule when the recording is triggered by a REST request. For this rule to be chosen, the 'role' field in the incoming REST request message must contain this same value.

The valid value is a string of up to 20 characters. By default, no value is defined.

For more information on SIPREC triggered by REST, see On-Demand SIPREC using REST.

Note: The parameter is applicable only when you configure the 'Trigger' parameter to REST.

Recording Server

'Recording Server (SRS) IP Group'

srs-ip-group-name

[SRSIPGroupName]

Assigns an IP Group from the IP Groups table (see Configuring IP Groups) to represent the SRS.

By default, no value is defined.

Note:

■ If you configure the parameter, use the default settings (i.e., not configured) for the 'Recording Server (SRS) IP Group Set' parameter.
■ The SIP Interface for communicating with the SRS is according to the SRD that is assigned to the SRS IP Group (in the IP Groups table). If two SIP Interfaces are associated with the SRD - one for "SBC" and one for "GW" – the device uses the "SBC" SIP Interface. If no SBC SIP Interface type is configured, the device uses the “GW” interface (which means that SRS redundancy isn't supported).

'Redundant Recording Server (SRS) IP Group'

srs-red-ip-group-name

[SRSRedundantIPGroupName]

Assigns an IP Group from the IP Groups table (see Configuring IP Groups) to represent the redundant SRS in the active-standby pair for SRS redundancy.

By default, no value is defined.

Note:

■ SRS redundancy is applicable only to the SBC application.
■ The IP Group of the redundant SRS must be different to the IP Group of the main SRS (see the 'Recording Server (SRS) IP Group' parameter).
■ If you configure the parameter, use the default settings (i.e., not configured) for the 'Recording Server (SRS) IP Group Set' parameter.

'Recording Server (SRS) IP Group Set'

srs-ip-group-set-name

[SRSIPGroupSetName]

Assigns an IP Group Set from the IP Group Set table (see Configuring IP Group Sets) to represent a group of SRSs (IP Groups) for load balancing. Each time the device sends SIPREC, it chooses a specific IP Group based on the IP Group Set's policy (i.e., round-robin, homing, or random weight).

By default, no value is defined.

Note:

■ This parameter is applicable only to the SBC application.
■ If you configure this parameter, use the default settings (i.e., not configured) for the 'Recording Server (SRS) IP Group' and 'Redundant Recording Server (SRS) IP Group' parameters.